home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / onread31.zip / READER.DOC < prev    next >
Text File  |  1992-08-24  |  14KB  |  351 lines
  1.                                                         
  2.                 Online Reader v3.1
  3.             (c) 1991, 1992 Elm L. Morrow
  4.             written in  Turbo Pascal  5.5
  5.                 utilizing RMDOOR 3.0
  6.  
  7.                    -by-
  8.  
  9.              Nocturnal Aviation Software
  10.                 E.L. Morrow
  11.  
  12.               911 N. Pacific Ave #15
  13.               Crescent City, CA 95531
  14.               Voice: (707) 465-6765
  15.  
  16.  
  17.         ******REPORT ALL HANGS IMMEDIATELY!!!!*********
  18.  
  19.  
  20.   DISCLAIMER:   
  21.     I relinquish any and all responsibility for anything that may
  22.   occur due to the use of this program, correctly or incorrectly.  I am
  23.   in no way libel for any damage that is attributed to the use of this
  24.   program by any and all persons.
  25.  
  26.  
  27.   SHAREWARE:
  28.     The Online Reader is ShareWare.  It's not crippled or
  29.   anything, but it does let your users know that it isn't registered by
  30.   showing #UNREGISTERED# at the top of the header on the file selection
  31.   menu.
  32.  
  33.     Registration is only $15 for this new version.  Future upgrades
  34.   will be priced accordingly depending on how much is changed and added.
  35.   Anyone who registers now will never have to pay for another registration
  36.   of this program.  Your registration number will be good for all versions.
  37.  
  38.     Distribution of this program will be solely the province of the
  39.   large number of BBS's across the country.  I can't afford to send disks
  40.   out to people who register.  I know this sounds kind of crude, but if
  41.   you enclose your BBS number when you register along with a password to
  42.   get on your system, I'll upload the latest version (if it's different) 
  43.   and send you a private message in an appropriate conference that will
  44.   list your registration information (just a reg number and name actually).
  45.  
  46.     Print and fill out the form in this archive called READER.REG
  47.   and mail it to:
  48.             Elm L. Morrow
  49.             911 N. Pacific Ave Apt 15
  50.             Crescent City, CA 95531
  51.  
  52.     Make checks or money orders payable to: Elm L. Morrow
  53.  
  54.  
  55.  
  56.   WHAT IT'S FOR:
  57.  
  58.     This door is for viewing text files while online.  At first,
  59.   you think to yourself, "that's nuts!  who wants to read stuff online?"
  60.   Well, this just might change your mind.
  61.  
  62.     Do you have long, important bulletins?  Nobody reads them because
  63.   it's such a pain.  Now they can read them with paging ability, a simple
  64.   search function and, if they decide it's important, they can download the
  65.   file straight from the door!
  66.  
  67.     This, however, is not the extent to which you can use this door.
  68.   Any text file you want your users to be able to access will work.  The
  69.   list of files includes a security rating, so you can have various types
  70.   of information for different levels of users.  You can display files
  71.   up to about 80 Kb.  If the file is larger than that it truncates it.
  72.   I'll work on giving it the ability to be more flexible as I go along,
  73.   but I think it's capable of holding large enough documents for most
  74.   people.
  75.  
  76.     I don't know what the format is for things like USA Today and any
  77.   other news service that's out there, but if they're just text files and
  78.   are within the size limit, there should be no problem using this door.
  79.   If anyone out there cares to give me the spec's on anything like this,
  80.   I'd be more than happy to work it into the reader.
  81.  
  82.                 I do have a filter operating that removes the TriBBS @ codes from
  83.   any document it displays.  This is for things like bulletins or news
  84.   files that contain these special formatting codes that you don't want
  85.   people to look at.  It doesn't remove them from the file, just refuses
  86.   to display them <grin>.  BTW, this filter works with the WildCAT! format
  87.   commands as well since they, coincidentally, have the same format.
  88.  
  89.     Please let me know of any other codes/strings that should be watched
  90.   for and filtered out of the display.
  91.  
  92.   SETTING UP:
  93.  
  94.     Ahhh.  Now we come to the fun part!  This reader requires a few files
  95.   besides itself to run.  One set is the configuration files and the other
  96.   is the list of files with descriptions and security levels that you want
  97.   to give people access to.
  98.  
  99.     Here is an example configuration file:
  100.  
  101.         PCB
  102.         C:\BBS
  103.         Works of Art BBS
  104.         Elm Morrow
  105.         0
  106.         not registered        (or a 0 or something)
  107.         C:\DOS\PKZIP.EXE
  108.         C:\DOS\GSZ.EXE
  109.  
  110.     The first line is the type of door file you are going to use.  In
  111.   this case, it's PCBOARD.  The full list is as follows:
  112.  
  113.         PCB for PCBoard, 
  114.         GAP for GAP (DOOR.SYS), 
  115.         SF for Spitfire, 
  116.                                 RBBS  for RBBS,
  117.                                 WC for  WildCat!,
  118.                                 TRIBBS for TriBBS, or
  119.                                 WWIV for WWIV.
  120.  
  121.     Line two tells the door what directory the door file generated by
  122.   the BBS will be in.  This is generally your node's main directory.  For
  123.   example, Node 1 on my board is C:\BBS\NODE1 and node 2 is C:\BBS\NODE2.
  124.  
  125.     Line three is the name of the BBS.  This is also the registration
  126.   name that you must use with your registration number.  More on that later.
  127.  
  128.     Line four is the SysOp's name.
  129.  
  130.     Line five is the speed at which your port is locked.  If you don't 
  131.   lock your port, then put a zero (0) on this line.
  132.  
  133.     Line six is your registration number.  Registration numbers are 
  134.   based on a somewhat random algorithm that is based upon the characters
  135.   of your BBS's name.  All of my utils have a different algorithm, so don't
  136.   get any ideas <grin>.
  137.  
  138.     Lines seven and eight are the full pathnames of the archiver (line 7)
  139.   and the protocol (line 8).
  140.  
  141.     The reader also needs three data files that essentially define your
  142.   list of files to view and the parameters of the download protocols.
  143.  
  144.                   VIEWLIST.DAT
  145.                   ------------
  146.   This file *must* reside in the same directory as the reader.  It is a 
  147.   simple text file that contains a list of entries that take this form:
  148.  
  149.     <d:\path\name.ext>,<file description>,<security>
  150.  
  151.     The first field is obvious.  You must tell the reader on what
  152.   drive and directory the file is.  There is no requirement that it be
  153.   in the directory you run the viewer from.
  154.  
  155.     <file description> can be up to 50 characters long, so you should
  156.   be able to get the point across.  This is what the users will see when
  157.   they are selecting the file from the Selection Menu.
  158.  
  159.     <security> is the level of security a user must have to be able to
  160.   read that specific file.
  161.  
  162.  
  163.                 PROTLIST.DAT
  164.                 ------------
  165.     This file contains the list and necessary information for the 
  166.   different type of protocols that the user will have at their disposal.
  167.   It is also a simple text file that contains one-line entries:
  168.  
  169.               <menu text>,<parameters>
  170.  
  171.     <menu text> is what the users will see when making their selection
  172.   of which protocol to use for the download.
  173.  
  174.     <parameters> is the command line that the protocol will need in
  175.   order to execute correctly.  The reader passes a number of parameters
  176.   to the program.  The only one that is absolutely required to be used is
  177.   the name of file to download parameter (%1).  The parameters are:
  178.  
  179.         %1      Name of file to download
  180.         %2      Baud rate
  181.         %3      Locked baud rate
  182.  
  183.     The following are examples of how to use the parameters:
  184.  
  185.         Zmodem (DSZ),port 2 speed %2 sz %1
  186.         YModem (DSZ),port 2 speed %2 sy %1
  187.  
  188.     After you have set these files up, you're door is ready to be put  
  189.   into use by your BBS.  I just want to stress again that it is not required     
  190.   that you run this as a PCBoard door.  The GAP door file (DOOR.SYS) is much
  191.   smaller and has all the information necessary.  You can use whatever format
  192.   you most like to use.  I just like PCBoard because most of my doors are
  193.   of that format (as a matter of fact, now that I think about it, the ALL
  194.   are!) so I prefer to use a single door type to keep from having multiple
  195.   door definition files laying around on my HD.
  196.  
  197.   
  198.   RUNNING THE DOOR:
  199.     The batch file for this door is simple.  Do something like this:
  200.  
  201.         CD C:\BBS\DOORS\READER
  202.         READER READER1.CFG
  203.         CD C:\BBS
  204.         BOARD
  205.  
  206.  
  207.   SPECIAL SYSOP KEYS:
  208.     These keys give you (the SysOp) the ability to do a number of things
  209.   while a user is in the middle of the door.   
  210.  
  211.      Key(s)              Function
  212.  
  213.      HOME                Toggles between the user status  window and a
  214.              help  display that  lists the  RMDoor special
  215.              keys.
  216.  
  217.      F6                  Takes 5 minutes away from the caller.
  218.  
  219.      F7                  Gives 5 minutes to the caller.
  220.  
  221.      F9                  Quit the  door and  return the caller  to the
  222.              BBS.
  223.  
  224.      F10                 Enter chat mode.   Pressing the ESC key exits
  225.              the chat mode.
  226.  
  227.      Alt+D               Drop to DOS.
  228.  
  229.  
  230.   USING THE DOOR:
  231.  
  232.     Now that you know how to set it up and how the SysOp stuff works,
  233.   lets talk about the other end of things.  The first thing the user will
  234.   see is a header that names the door and me and lets them know if you're
  235.   registered or not.  Just below this will be a box with a list of file
  236.   description for the user to choose from.  If there are more than will fit
  237.   in the box at a time, just move the cursor down past the bottom and the
  238.   next page will come up.
  239.  
  240.     I've never bottomed out the total number of entries that the menu
  241.   can handle, but I'm confident that it's well over a hundred.  Basically,
  242.   the size of your VIEWLIST.DAT can be up to 80 Kb!  That's a *lot* of file
  243.   descriptions.
  244.  
  245.     When you have the arrows pointing at the file you want to view, 
  246.   press <ENTER> to view it.  If you changed your mind and you want to leave
  247.   the door, press <ESC> and it will exit the door.
  248.  
  249.     After you select a file, it will load and the first page will come
  250.   up on the screen.  Because of formatting restrictions for the SysOps side
  251.   of the display (the SysOp status screen takes up several lines), the 
  252.   window for viewing files isn't very large.  Hopefully, it's adequate for
  253.   whatever you're doing.
  254.  
  255.     Currently the only features implemented are Page Up <8>, Page 
  256.   Down <2>, Search <S>, Search Again <A>, and Download <D>.  More features
  257.   will be put in place once the current ones have been fully tested and
  258.   optimized.  Feel free to make suggestions.  I'll probably use them!
  259.  
  260.     Pressing S to search will put a prompt at the bottom of the window
  261.   asking you for a string to search for.  Just enter whatever you like and
  262.   press <ENTER>.  Searches are =CASE SENSITIVE=.  I'll be adding options for
  263.   searching in a later version.
  264.  
  265.     Search Again will do just that.  There is a limitation, however.  
  266.   If you page up or down, it will clear the search string from memory and
  267.   you'll have to enter it again.
  268.  
  269.     The selection of archiver and protocol work exactly the same way
  270.   that the Selection menu does.  Simply press <2> for up or <8> for down
  271.   until the selection you want is being pointed to by the arrows, then
  272.   press <ENTER>.
  273.  
  274.  
  275.   WRAP UP:
  276.     Sound pretty limited?  Well, it is.  So why should you cough up
  277.   $15 for it?  Well, it would be a shrewd maneuver on your part because
  278.   the price will go up the better the door gets.  As a matter of fact, the
  279.   price has already gone up since the first version. As I stated at the start
  280.   of this .DOC file, anyone who registers this program will never have to
  281.   register it again, no matter how much the price goes up.  That's my
  282.   part of the deal.  You support me when I'm first working things out with
  283.   this door and I keep updating it and making it better.  People who wait
  284.   until it's more advanced will have to pay a higher price!
  285.  
  286.  
  287.   SUGGESTIONS, ETC...:
  288.  
  289.     Please leave your suggestions for improvements and any other 
  290.   comments on one or more of the following boards:
  291.  
  292.     The WheelChair Express
  293.     (707) 464-3705  Node 1
  294.     (707) 465-1272  Node 2
  295.  
  296.     Conference:  Nocturnal Support
  297.  
  298.     
  299.     Of course, there's always snail mail.  As a general rule, I don't
  300.   like answering letters, but if you send a check or m.o. for $15 with a
  301.   letter, I'll more than likely get in touch with you one way or the other.
  302.  
  303.     If I've missed something or you can't make sense out of all or part
  304.   of this .DOC file, get in touch and let me know.  It's really not that
  305.   hard to get it set up, but I don't always feel like writing and so the
  306.   descriptions of how to do things get erratic and confusing.  <Sigh>
  307.  
  308.   HISTORY:
  309.  
  310.     Version's 1.0 through 1.2 were essentially ßeta versions of the
  311.   door.  Version 1.1 added minor formatting and version 1.2 was a fairly
  312.   major addition to the download function.
  313.  
  314.     Version 1.3 was released only because my registered version  of
  315.   rmDoor showed up and it only gets rid of the ShareWare notice that comes
  316.   up when someone enters the door.
  317.  
  318.     Version 2.0 is now multinode and will work just fine with TriTel
  319.   v2.0.  Please let me know immediately! if there are any problems running
  320.   this door on your system.  This is one of my first multi-node doors and
  321.   there may still be some bugs in it.
  322.  
  323.     Version 2.1 fixed a minor programming snafu.  The downloading 
  324.   function should now be back up and usable.  Also recompiled using
  325.   rmDoor v2.0 which fixes the Drop to DOS and chat functions.
  326.  
  327.     Version 2.2 finished cleaning up what v2.1 was supposed to do.
  328.  
  329.     Version 2.3 has been an attempt to clear up the downloading
  330.         problem.  So far it has met with total failure.  I
  331.         think this may be being caused by my share UNIT, so
  332.         this single node release may take care of the problem
  333.         for a lot of you out there.  The multinode release
  334.         may take a considerable amount of time while I
  335.         either rewrite using a new file sharing UNIT, limit
  336.         the file size and elmininate the swap to EMS/disk,
  337.         or some other drastic measure.
  338.  
  339.     Version 3.0 has changed so that DesqView will no longer cause
  340.         strange things to happen when the program swaps to
  341.         EMS/disk by eliminating the swap <sigh>.  Knocked a couple
  342.         of bucks off the price.
  343.  
  344.        Version 3.1 has been recompiled using rmDoor v3.0 in order to fix
  345.         the problem that was being experienced by high speed nodes.
  346.  
  347.         There has also been a bug fix that I was alerted to that
  348.         didn't allow the user to download a file if it wasn't in
  349.         the same directory as the door.  All fixed <grin>.
  350.  
  351.